<html>
    <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>Hammerspoon docs: ForceTouchMapper</title>
    <style type="text/css">
      a { text-decoration: none; }
      a:hover { text-decoration: underline; }
      th { background-color: #DDDDDD; vertical-align: top; padding: 3px; }
      td { width: 100%; background-color: #EEEEEE; vertical-align: top; padding: 3px; }
      table { width: 100% ; border: 1px solid #0; text-align: left; }
      section > table table td { width: 0; }
    </style>
    <link rel="stylesheet" href="docs.css" type="text/css" media="screen" />
  </head>
  <body>
    <header>
      <h1><a href="./index.html">docs</a> &raquo; ForceTouchMapper</h1>
      <p>Maps force touch clicks in specified apps to a hot key</p>
<p>Example use:
<code>spoon.SpoonInstall:andUse(&quot;ForceTouchMapper&quot;, { config = {apps = {[&quot;com.microsoft.VSCode&quot;] = {keyStroke = {{&quot;cmd&quot;}, 'y'}}}} })</code>
which will invoke <code>cmd+y</code> keystroke when you force click some definition in VS Code.</p>
<p>I have this key binding in VS Code for peek definition</p>
<p><code>{ &quot;key&quot;: &quot;cmd+y&quot;, &quot;command&quot;: &quot;editor.action.peekDefinition&quot;, &quot;when&quot;: &quot;editorHasDefinitionProvider &amp;&amp; editorTextFocus &amp;&amp; !inReferenceSearchEditor &amp;&amp; !isInEmbeddedEditor&quot; }</code>
,</p>
<p>Download: <a href="https://github.com/Hammerspoon/Spoons/raw/master/Spoons/ForceTouchMapper.spoon.zip">https://github.com/Hammerspoon/Spoons/raw/master/Spoons/ForceTouchMapper.spoon.zip</a></p>

      </header>
      <h3>API Overview</h3>
      <ul>
        <li>Variables - Configurable values</li>
          <ul>
            <li><a href="#apps">apps</a></li>
          </ul>
        <li>Methods - API calls which can only be made on an object returned by a constructor</li>
          <ul>
            <li><a href="#start">start</a></li>
          </ul>
      </ul>
      <h3>API Documentation</h3>
        <h4 class="documentation-section">Variables</h4>
          <section id="apps">
            <a name="//apple_ref/cpp/Variable/apps" class="dashAnchor"></a>
            <h5><a href="#apps">apps</a></h5>
            <table>
              <tr>
                <th>Signature</th>
                <td><code>ForceTouchMapper.apps</code></td>
              </tr>
              <tr>
                <th>Type</th>
                <td>Variable</td>
              </tr>
              <tr>
                <th>Description</th>
                <td><p>Table of bundle ids of apps in which you want to map forcetouch to keyStroke</p>
</td>
              </tr>
              <tr>
                <th>Source</th>
                <td><a href="https://github.com/Hammerspoon/Spoons/blob/master/Source/ForceTouchMapper.spoon/init.lua#L31">Source/ForceTouchMapper.spoon/init.lua line 31</a></td>
              </tr>
            </table>
          </section>
        <h4 class="documentation-section">Methods</h4>
          <section id="start">
            <a name="//apple_ref/cpp/Method/start" class="dashAnchor"></a>
            <h5><a href="#start">start</a></h5>
            <table>
              <tr>
                <th>Signature</th>
                <td><code>ForceTouchMapper:start()</code></td>
              </tr>
              <tr>
                <th>Type</th>
                <td>Method</td>
              </tr>
              <tr>
                <th>Description</th>
                <td><p>Start ForceTouchMapper</p>
</td>
              </tr>
              <tr>
                  <th>Parameters</th>
                  <td><ul>
<li>None</li>
</ul>
</td>
              </tr>
              <tr>
                  <th>Returns</th>
                  <td></td>
              </tr>
              <tr>
                <th>Source</th>
                <td><a href="https://github.com/Hammerspoon/Spoons/blob/master/Source/ForceTouchMapper.spoon/init.lua#L55">Source/ForceTouchMapper.spoon/init.lua line 55</a></td>
              </tr>
            </table>
          </section>
  </body>
</html>